Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

User Forms

When built locally (see doc/README.md) the mdbook generator has access to the user's slosh environment. This enables creating documentation in md form of all user defined functions. The user's init.slosh is automatically loaded, so any additional files it loads are also imported. If the user needs to alter the slosh load path or add additional files to be loaded (presumably because they aren't imported in init.slosh or any slosh file it imports) it can be done by adding the paths in the user-doc-files and user-doc-load-paths string arrays in doc/book.toml. The default is to use ~/.config/slosh/ as the load path and ~/.config/slosh/init.slosh for the rc file.

List of sections: